Finance APIs
List of general ledger account
HTTP method | GET |
URI | https://api.rambase.net/finance/general-ledger-accounts?periodForTotals={periodId} |
Supported formats | Xml, Html, Json (ex. $format=json) |
Maximum page size ($top) | 80 |
Successful HTTP status code | 200 |
API resource identifier | 489, version 34 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
periodForTotals Integer, optional |
Accounting period identifier
Minimum: 199000, Maximum: 299912 |
$showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
$lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
$access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
$db String, optional | Set the database/company for the request |
$expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information. |
$select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
$useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
$format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
$top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
$pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
$filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
$orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
$inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
Active() Named filter | Active general ledger accounts (status equal 4) |
NewAndActive() Named filter | New and active general ledger accounts (status less than 9) |
AccountNumber String | The account number of the general ledger account. |
AssetRequirement String | Specifies how the dimension should be used for the specific account. |
BudgetAccountId Integer | Budget account identifier. |
Category String | Category of account. |
DepartmentRequirement String | Specifies how the dimension should be used for the specific account. |
DepreciationRuleId Integer | Depreciation rule identifier. |
Description String | Description of account. |
EffectivePeriod Integer | Period the account is effective/valid from. |
ExpirationPeriod Integer | Period the account expires (is valid to). |
GeneralLedgerAccountGroupId Integer | General ledger account group identifier. |
GeneralLedgerAccountId Integer | General ledger account identifier. |
IsAgioCalculated Boolean | True if general ledger account is agio calculated. |
IsControlAccount Boolean | True if general ledger account is a control account. |
LastGeneralLedgerPostingPeriod Integer | Last general ledger posting period of account. |
Name String | Name of general ledger account. |
ParentGeneralLedgerAccountId Integer | Parent general ledger account identifier. |
PostingType String | Posting type of account. Only debit, only credit or both. |
ProjectRequirement String | Specifies how the dimension should be used for the specific account. |
SAFTCode String | SAF-T standard code. |
Status Integer | Status of general ledger account. |
Type String | Type of account. |
UpdatedAt Datetime | Date and time of update. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
VATCode String | Code that determines VAT rules used for VAT calculations. |
Read more about filters and sorting on how to use sortable parameters
AccountNumber String | The account number of the general ledger account |
AssetRequirement String | Specifies how the dimension should be used for the specific account. |
BudgetAccountId Integer | Budget account identifier |
Category String | Category of account |
DepartmentRequirement String | Specifies how the dimension should be used for the specific account. |
DepreciationRuleId Integer | Depreciation rule identifier |
Description String | Description of account |
EffectivePeriod Integer | Period the account is effective/valid from |
ExpirationPeriod Integer | Period the account expires (is valid to) |
GeneralLedgerAccountGroupId Integer | General ledger account group identifier |
GeneralLedgerAccountId Integer | General ledger account identifier |
IsAgioCalculated Boolean | True if general ledger account is agio calculated |
IsControlAccount Boolean | True if general ledger account is a control account |
LastGeneralLedgerPostingPeriod Integer | Last general ledger posting period of account |
Name String | Name of general ledger account |
ParentGeneralLedgerAccountId Integer | Parent general ledger account identifier. |
PostingType String | Posting type of account. Only debit, only credit or both. |
ProjectRequirement String | Specifies how the dimension should be used for the specific account. |
SAFTCode String | SAF-T standard code |
Status Integer | Status of general ledger account |
Type String | Type of account |
UpdatedAt Datetime | Date and time of update |
VATCode String | Code that determines VAT rules used for VAT calculations. |
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
GeneralLedgerAccountId
General ledger account identifier
>{Integer}</GeneralLedgerAccountId>Status
Status of general ledger account
Possible domain values can be found here
>{Integer}</Status>Name
Name of general ledger account
>{String}</Name>PostingType
Posting type of account. Only debit, only credit or both.
Possible domain values can be found here
>{String}</PostingType>TreeLevel
Level in the general ledger account tree. 0 is the root.
>{Integer}</TreeLevel>IsControlAccount
True if general ledger account is a control account
>{Boolean}</IsControlAccount>Description
Description of account
>{String}</Description>AccountNumber
The account number of the general ledger account
>{String}</AccountNumber>IsAgioCalculated
True if general ledger account is agio calculated
>{Boolean}</IsAgioCalculated>VATPercent
Value added tax percent
>{Decimal}</VATPercent>LastGeneralLedgerPostingPeriod
Last general ledger posting period of account
>{Integer}</LastGeneralLedgerPostingPeriod>EffectivePeriod
Period the account is effective/valid from
>{Integer}</EffectivePeriod>ExpirationPeriod
Period the account expires (is valid to)
>{Integer}</ExpirationPeriod>BudgetAccountId
Budget account identifier
>{Integer}</BudgetAccountId>BudgetAccountLink
Budget reference
>{String}</BudgetAccountLink>VATCode
Code that determines VAT rules used for VAT calculations.
>{String}</VATCode>GeneralLedgerAccountGroupId
General ledger account group identifier
>{Integer}</GeneralLedgerAccountGroupId>Code
Code of general ledger account group
>{String}</Code>Name
Name of general ledger account group
>{String}</Name>GeneralLedgerAccountGroupLink
General ledger account group reference
>{String}</GeneralLedgerAccountGroupLink>DepreciationRuleId
Depreciation rule identifier
>{Integer}</DepreciationRuleId>DepreciationRuleLink
Depreciation rule reference
>{String}</DepreciationRuleLink>GeneralLedgerAccountId
General ledger account identifier
>{Integer}</GeneralLedgerAccountId>TreeLevel
Level in the general ledger account tree. 0 is the root.
>{Integer}</TreeLevel>GeneralLedgerAccountLink
General ledger account reference
>{String}</GeneralLedgerAccountLink>GeneralLedgerAccountLink
General ledger account reference
>{String}</GeneralLedgerAccountLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>GeneralLedgerAccountId
General ledger account identifier
": "{Integer}",Status
Status of general ledger account
Possible domain values can be found here
": "{Integer}",Name
Name of general ledger account
": "{String}",Type
Type of account
Possible domain values can be found here
": "{String}",Category
Category of account
Possible domain values can be found here
": "{String}",PostingType
Posting type of account. Only debit, only credit or both.
Possible domain values can be found here
": "{String}",TreeLevel
Level in the general ledger account tree. 0 is the root.
": "{Integer}",IsControlAccount
True if general ledger account is a control account
": "{Boolean}",Description
Description of account
": "{String}",AccountNumber
The account number of the general ledger account
": "{String}",IsAgioCalculated
True if general ledger account is agio calculated
": "{Boolean}",VATPercent
Value added tax percent
": "{Decimal}",LastGeneralLedgerPostingPeriod
Last general ledger posting period of account
": "{Integer}",EffectivePeriod
Period the account is effective/valid from
": "{Integer}",ExpirationPeriod
Period the account expires (is valid to)
": "{Integer}"BudgetAccountId
Budget account identifier
": "{Integer}",BudgetAccountLink
Budget reference
": "{String}"VATCode
Code that determines VAT rules used for VAT calculations.
": "{String}",GeneralLedgerAccountGroupId
General ledger account group identifier
": "{Integer}",Code
Code of general ledger account group
": "{String}",Name
Name of general ledger account group
": "{String}",GeneralLedgerAccountGroupLink
General ledger account group reference
": "{String}"DepreciationRuleId
Depreciation rule identifier
": "{Integer}",DepreciationRuleLink
Depreciation rule reference
": "{String}"GeneralLedgerAccountId
General ledger account identifier
": "{Integer}",TreeLevel
Level in the general ledger account tree. 0 is the root.
": "{Integer}",GeneralLedgerAccountLink
General ledger account reference
": "{String}"GeneralLedgerAccountLink
General ledger account reference
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
Error 100169 HTTP 404 | General ledger account not found : {0} |
Error 101420 HTTP 404 | Setting definition not found |